IMotion.RemoveAxisFromGroup method

Removes an axis from a group. The command can't be buffered. If there is no axis left in the group, the state changes to GroupDisabled.

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsError RemoveAxisFromGroup(
       int Index,
       int IndexInGroup
)

Function RemoveAxisFromGroup(
       Index As Integer,
       IndexInGroup As Integer
) As KsError

Parameters

Index [in]

Type: int

The index of an axis group. Indexes are zero based. You can have up to 32 groups.

IndexInGroup [in]

Type: int

The index of an axis in the group.

Return value

A return code of a method.

Remarks

If sent to a group that is not in GroupDisabled, GroupStandstill or GroupErrorStop, it generates an error and the function is not executed.

Examples

N/A